Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Update Storybook to v8 #234

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

dylanbox
Copy link

Overview

Updates the storybook install to the new version, v8, and updates stories to the new format. This is a prerequisite for implementing the design-system, as we want to use the new storybook inheritance and visual testing suite.

Security

REMINDER: All file contents are public.

  • I have ensured no secure credentials or sensitive information remain in code, metadata, comments, etc.
    • Please verify that you double checked that .storybook/preview.js does not contain your participant access key details.
    • There are no temporary testing changes committed such as API base URLs, access tokens, print/log statements, etc.
  • These changes do not introduce any security risks, or any such risks have been properly mitigated.

Describe briefly what security risks you considered, why they don't apply, or how they've been mitigated.

Checklist

Testing

Documentation

  • I have added relevant Storybook updates to this PR as well.
  • If this feature requires a developer doc update, tag @CareEvolution/api-docs.

Consider "Squash and merge" as needed to keep the commit history reasonable on main.

Reviewers

Assign to the appropriate reviewer(s). Minimally, a second set of eyes is needed ensure no non-public information is published. Consider also including:

  • Subject-matter experts
  • Style/editing reviewers
  • Others requested by the content owner

"@storybook/addon-links",
"@storybook/addon-essentials",
"@storybook/addon-interactions",
"@storybook/addon-mdx-gfm",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reading this add on will be likely be removed in a future version. Is there a strong reason for including this vs following the recommended instructions? https://www.npmjs.com/package/@storybook/addon-mdx-gfm

@ClaysGit
Copy link
Member

@CodiumAI-Agent /review

@CodiumAI-Agent
Copy link

PR Review 🔍

⏱️ Estimated effort to review [1-5]

2, because the PR primarily involves version updates and straightforward changes to configuration and documentation files. The changes are mostly clear and well-documented, making the review process less complex.

🧪 Relevant tests

No

⚡ Possible issues

Possible Dependency Issue: The addition of new Storybook addons (@storybook/addon-mdx-gfm and @storybook/addon-webpack5-compiler-babel) should be checked for compatibility with existing project dependencies and configurations to avoid conflicts or runtime errors.

🔒 Security concerns

No

Code feedback:
relevant file.storybook/main.js
suggestion      

Consider verifying the compatibility of newly added Storybook addons with the existing project setup. This is important to ensure that the new addons do not introduce any build or runtime issues. [important]

relevant line"@storybook/addon-mdx-gfm",

relevant filepackage.json
suggestion      

Ensure that all newly added or updated Storybook packages (@storybook/addon-mdx-gfm, @storybook/addon-webpack5-compiler-babel, etc.) are compatible with other project dependencies. This can prevent potential issues from incompatible package versions. [important]

relevant line"@storybook/addon-mdx-gfm": "^8.0.4",

relevant filesrc/stories/Introduction.mdx
suggestion      

Review the CSS changes for potential impacts on layout and styling across different browsers, especially the changes in media queries and grid settings. This helps ensure consistent UI/UX in various environments. [medium]

relevant line@media (min-width: 620px) {

relevant filesrc/stories/Introduction.mdx
suggestion      

Check the updated import path for Meta from @storybook/blocks to ensure it aligns with the new Storybook documentation and functionality, as import paths can often lead to breaking changes if not correctly updated. [important]

relevant lineimport { Meta } from '@storybook/blocks';

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants